/*
 * StatusResponse.java   ver    31 Oct 2009
 * 
 * Copyright (c) 2009 mentalsmash.org
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The use of the Apache License does not indicate that this project is
 * affiliated with the Apache Software Foundation.
 */
package org.mentalsmash.tazio.transactions.management;

import java.io.Serializable;

/**
 * This enumeration is used as a response message to enquires on RM about the
 * outcome of a transaction
 * 
 * @author Andrea Reale
 * @version 0.0.1
 */
public interface StatusResponse extends Serializable {

    /**
     * Returns the status of the transactions as one of the values of the
     * enumeration {@link StatusResponseEnum}
     * 
     * @return the status of the transactions as one of the values of the
     *         enumeration {@link StatusResponseEnum}
     */
    StatusResponseEnum getStatus();

    /**
     * If {@link #getStatus()} returns {@link StatusResponseEnum#COMMITTED}
     * returns the sequence number the transaction was committed with. Otherwise
     * it returns null.
     * 
     * @return If {@link #getStatus()} returns
     *         {@link StatusResponseEnum#COMMITTED} returns the sequence number
     *         the transaction was committed with. Otherwise it returns null.
     */
    Long getSeqNo();

    /**
     * This enumeration is used as a response message to enquires on RM about
     * the outcome of a transaction
     * 
     * @author Andrea Reale
     * @version 0.0.1
     */
    enum StatusResponseEnum {

	/**
	 * The transaction has successfully committed on the RM
	 */
	COMMITTED,
	/**
	 * The transaction was rolled back on the RM
	 */
	ROLLED_BACK,
	/**
	 * The transaction is being validated by the RM
	 */
	ACTIVE,
	/**
	 * The RM has never heard anything about that transaction
	 */
	UNKNOWN

    }
}
